docs: SECURITY.md + security architecture + threat model#69
Merged
Conversation
…eat model Three new/updated user-facing security docs aimed at OSS auditors and researchers: - SECURITY.md (rewrite): private vulnerability reporting via GitHub advisories; safe-harbor language; explicit in/out of scope; clear triage timelines and credit policy. - docs/operations/security-architecture.md (new): components, crypto primitives + parameters, auth/authz model, network exposure, outbound-traffic surfaces, validation pipelines, audit/logging, DoS controls, build pipeline, recommended audit entry points, documented design trade-offs. - docs/operations/threat-model.md (new): trust principals, in-scope adversaries, explicit out-of-scope adversaries, ASCII boundary diagram, six documented design trade-offs (super_admin = host root, master_secret single-root-of-trust, recipes TOFU, audit operator- trust, tls.mode off permitted, unsigned release artifacts), and a list of cross-cutting invariants a researcher should expect to verify. The Operations sidebar autogenerates so no astro.config edit is needed. Care taken to describe the design at the level a researcher needs without giving attackers a roadmap: parameters and primitives are listed, but specific bypass techniques and unfixed weaknesses are not.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds OSS-audience security documentation aimed at researchers and downstream auditors. Rewrites SECURITY.md (private GH advisories, safe harbor, scope, timelines), adds /operations/security-architecture/ (components, primitives, controls), adds /operations/threat-model/ (trust principals, in/out of scope, design trade-offs, invariants to verify). Care taken to describe design choices without giving attackers a roadmap.